<?php

/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage Gapps
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Nickname.php 16971 2009-07-22 18:05:45Z mikaelkael $
 */

/**
 * @see Zend_Gdata_Extension
 */
require_once 'Zend/Gdata/Extension.php';

/**
 * @see Zend_Gdata_Gapps
 */
require_once 'Zend/Gdata/Gapps.php';

/**
 * Represents the apps:nickname element used by the Apps data API. This
 * is used to describe a nickname's properties, and is usually contained
 * within instances of Zend_Gdata_Gapps_NicknameEntry.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage Gapps
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Gdata_Gapps_Extension_Nickname extends Zend_Gdata_Extension
{

	protected $_rootNamespace = 'apps';
	protected $_rootElement = 'nickname';

	/**
	 * The name of the nickname. This name is used as the email address
	 * for this nickname.
	 *
	 * @var string
	 */
	protected $_name = null;

	/**
	 * Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.
	 * @param string $name (optional) The nickname being represented.
	 */
	public function __construct($name = null)
	{
		$this->registerAllNamespaces(Zend_Gdata_Gapps::$namespaces);
		parent::__construct();
		$this->_name = $name;
	}

	/**
	 * Retrieves a DOMElement which corresponds to this element and all
	 * child properties.  This is used to build an entry back into a DOM
	 * and eventually XML text for sending to the server upon updates, or
	 * for application storage/persistence.
	 *
	 * @param DOMDocument $doc The DOMDocument used to construct DOMElements
	 * @return DOMElement The DOMElement representing this element and all
	 * child properties.
	 */
	public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
	{
		$element = parent::getDOM($doc, $majorVersion, $minorVersion);
		if ($this->_name !== null) {
			$element->setAttribute('name', $this->_name);
		}
		return $element;
	}

	/**
	 * Given a DOMNode representing an attribute, tries to map the data into
	 * instance members.  If no mapping is defined, the name and value are
	 * stored in an array.
	 *
	 * @param DOMNode $attribute The DOMNode attribute needed to be handled
	 */
	protected function takeAttributeFromDOM($attribute)
	{
		switch ($attribute->localName) {
			case 'name':
				$this->_name = $attribute->nodeValue;
				break;
			default:
				parent::takeAttributeFromDOM($attribute);
		}
	}

	/**
	 * Get the value for this element's name attribute.
	 *
	 * @see setName
	 * @return string The requested attribute.
	 */
	public function getName()
	{
		return $this->_name;
	}

	/**
	 * Set the value for this element's name attribute. This name uniquely
	 * describes this nickname within the domain. Emails addressed to this
	 * name will be delivered to the user who owns this nickname.
	 *
	 * @param string $value The desired value for this attribute.
	 * @return Zend_Gdata_Gapps_Extension_Nickname Provides a fluent
	 *          interface.
	 */
	public function setName($value)
	{
		$this->_name = $value;
		return $this;
	}

	/**
	 * Magic toString method allows using this directly via echo
	 * Works best in PHP >= 4.2.0
	 */
	public function __toString()
	{
		return $this->getName();
	}

}
